10.1场景联动规则管理

提供在云端上新建规则、根据ID查询规则详情、编辑规则、根据ID删除规则的、对规则的分页带条件查询、启用/禁用规则、根据ID列表批量删除规则、批量启用/禁用规则的功能

10.1.1新建规则

功能描述：提供新建规则的功能，入参为规则具体内容，返回新增结果。

POST  /api/v1/rules

Body:

conditions的子对象结构体：

filter的子对象结构体：

filterDevice的子对象结构体：

filterTime的子对象结构体：

actions的子对象结构体：

Body example:

Body中含有actions和conditions的情况:
{
  "actions": [
    {
      "deviceId": 10000781,      
      "identifier": "abcd",
      "productId": 100235,    
      "value": "true"
    }
  ],
  "conditions": [
    {
      "didList": [
        10000781
      ],
      "operand": "true",
      "operation": "!=",
      "parameter": "abcd",
      "productId": 100235,
      "type": 2
    }
  ],
  "name": "string",
  "ruleType": 1
}

Body中含有timeTrigger和actions的情况:
{
  "timeTrigger": "0 0 3,18 * * ?",
  "actions": [
      {
        "deviceId": 10000781,      
        "identifier": "abcd",
        "productId": 100235,    
        "value": "true"
      }
    ],  
  "name": "strrringw2111",
  "ruleType": 1
}

Body中含有exportClientId和conditions的情况:
{
  "exportClientId": 10267,
  "conditions": [
      {
        "didList": [
          10000781
        ],
        "operand": "true",
        "operation": "!=",
        "parameter": "abcd",
        "productId": 100235,
        "type": 2
      }
    ],
  "name": "strrringw2f111",
  "ruleType": 1
}

Body中含有timeTrigger和subscription的情况:
{
  "timeTrigger": "0 0 3,18 * * ?",
  "subscription": ["1980361262@qq.com"],  
  "name": "strrringw2111",
  "ruleType": 1
}

cURL example:

Body中含有actions和conditions的情况:
   curl --location --request POST '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/rules?accessKeyId={accessKeyId}&signature={signature}&signatureNonce=646' \
 --header 'platform: 1' \
 --header 'projectId: {projectId}' \
 --header 'Content-Type: application/json' \
 --data-raw '{
   "actions": [
     {
       "deviceId": 10000781,
       "identifier": "abcd",
       "productId": 100235,
       "value": "true"
     }
   ],
   "conditions": [
     {
       "didList": [
         10000781
       ],
       "operand": "true",
       "operation": "!=",
       "parameter": "abcd",
       "productId": 100235,
       "type": 2
     }
   ],
   "name": "string11",
   "ruleType": 1
 }'

Body中含有timeTrigger和actions的情况:
curl --location --request POST '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/rules?accessKeyId={accessKeyId}&signature={signature}&signatureNonce=646' \
 --header 'platform: 1' \
 --header 'projectId: {projectId}' \
 --header 'Content-Type: application/json' \
 --data-raw '{
               "timeTrigger": "0 0 3,18 * * ?",
               "actions": [
                   {
                     "deviceId": 10000781,      
                     "identifier": "abcd",
                     "productId": 100235,    
                     "value": "true"
                   }
                 ],  
               "name": "strrringw2111",
               "ruleType": 1
             }'

Body中含有exportClientId和conditions的情况:
curl --location --request POST '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/rules?accessKeyId={accessKeyId}&signature={signature}&signatureNonce=646' \
 --header 'platform: 1' \
 --header 'projectId: {projectId}' \
 --header 'Content-Type: application/json' \
 --data-raw '{
               "exportClientId": 10267,
               "conditions": [
                   {
                     "didList": [
                       10000781
                     ],
                     "operand": "true",
                     "operation": "!=",
                     "parameter": "abcd",
                     "productId": 100235,
                     "type": 2
                   }
                 ],
               "name": "strrringw2f111",
               "ruleType": 1
             }'

Body中含有timeTrigger和subscription的情况:
curl --location --request POST '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/rules?accessKeyId={accessKeyId}&signature={signature}&signatureNonce=646' \
 --header 'platform: 1' \
 --header 'projectId: {projectId}' \
 --header 'Content-Type: application/json' \
 --data-raw '{
               "timeTrigger": "0 0 3,18 * * ?",
               "subscription": ["1980361262@qq.com"],  
               "name": "strrringw2111",
               "ruleType": 1
             }'

Response:

Response example:

{
    "success": true,
    "code": 0,
    "msg": null,
    "data": "8ae491be7096bd2301709a46d7170009"
}

10.1.2获取详细规则信息

功能描述：提供根据id查询规则详情的功能，返回规则详情。

GET  /api/v1/rules/{ruleId}

Path:

cURL example:

   curl --location --request GET '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/rules/{ruleId}?accessKeyId={accessKeyId}&signature={signature}&signatureNonce=646' \
--header 'projectId: {projectId}' \ 
--header 'platform: 1'

Response data:

Response data conditions的子对象结构体:

Response data check的子对象结构体:

Response data actions的子对象结构体:

Response example:

{
  "success": true,
  "code": 0,
  "msg": null,
  "data": {
            "id": "8ae48daf7163309a0171ee0575150010",
            "name": "string111",
            "userId": "1bb9909ee93647df883b9043743a345d",
            "userName": "liubo3",
            "timeTrigger": null,
            "conditions": [
                {
                    "productName": "cdedd",
                    "productId": 100235,
                    "protocolType": 5,
                    "labelId": null,
                    "labelName": null,
                    "check": {
                        "parameter": "abcd",
                        "operation": "!=",
                        "operand": "true",
                        "type": 2
                    },
                    "type": 2,
                    "nameList": [
                        "crcr"
                    ],
                    "didList": [
                        10000781
                    ]
                }
            ],
            "filters": [],
            "actions": [
                {
                    "deviceId": 10000781,
                    "deviceName": "crcr",
                    "productName": "cdedd",
                    "productId": 100235,
                    "protocolType": 5,
                    "identifier": "abcd",
                    "value": "true",
                    "type": 2
                }
            ],        
            "subscription": [],
            "mailServerId": "",
            "mailServerName": "",
            "mailPatternId": "",
            "mailPatternName": "",           
            "export": false,
            "exportClientId": null,           
            "ruleType": 1,
            "status": "DISABLED"
  }
}

10.1.3更新规则

功能描述：更新规则的功能，入参为规则具体内容。

PUT  /api/v1/rules/{ruleId}

Path:

Body:

conditions的子对象结构体：

filter的子对象结构体：

filterDevice的子对象结构体：

filterTime的子对象结构体：

actions的子对象结构体：

Body example:

{
  "actions": [
    {
      "deviceId": 10000781,
      "identifier": "abcd",
      "productId": 100235,
      "value": "true"
    }
  ],
  "conditions": [
    {
      "didList": [
        10000781
      ],
      "operand": "true",
      "operation": "==",
      "parameter": "abcd",
      "productId": 100235,
      "type": 2
    }
  ],
  "name": "string111",
  "ruleType": 1
}

cURL example:

   curl --location --request PUT '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/rules/{ruleId}?accessKeyId={accessKeyId}&signature={signature}&signatureNonce=646' \
 --header 'platform: 1' \
 --header 'projectId: {projectId}' \
 --header 'Content-Type: application/json' \
 --data-raw '{
  "actions": [
    {
      "deviceId": 10000781,
      "identifier": "abcd",
      "productId": 100235,
      "value": "true"
    }
  ],
  "conditions": [
    {
      "didList": [
        10000781
      ],
      "operand": "true",
      "operation": "==",
      "parameter": "abcd",
      "productId": 100235,
      "type": 2
    }
  ],
  "name": "string111",
  "ruleType": 1
}'

Response example:

{    
    "success": true,
    "code": 0,
    "msg": null,
    "data": null
}

10.1.4通过id删除规则

功能描述：提供根据id删除规则的功能，返回删除结果。

DELETE  /api/v1/rules/{ruleId}

Path:

Query:

cURL example:

   curl --location --request DELETE '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/rules/{ruleId}?accessKeyId={accessKeyId}&signature={signature}&signatureNonce=646' \
 --header 'platform: 1' \
 --header 'projectId: {projectId}'

Response example:

{
  "success": true,
  "code": 0,
  "msg": null,
  "data": null
}

10.1.5查询符合条件的规则

功能描述：提供对规则的分页带条件查询功能，返回规则列表。

GET  /api/v1/rules

Query:

cURL example:

   curl --location --request GET '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/rules/{ruleId}?accessKeyId={accessKeyId}&signature={signature}&signatureNonce=646&currentPage={currentPage}&pageSize={pageSize}' \
 --header 'platform: 1' \
 --header 'projectId: {projectId}'

Response data:

Response data content的子对象结构体:

Response data conditions的子对象结构体:

Response data check的子对象结构体:

Response data actions的子对象结构体:

Response example:

{
  "success": true,
  "code": 0,
  "msg": "",
  "data": {
    "currentPage": 1,
    "pageSize": 10,
    "totalCount": 1,
    "totalPage": 1,
    "content": [
                 {
                    "id": "8ae48daf7163309a0171ee0575150010",
                    "name": "string111",
                    "userId": "1bb9909ee93647df883b9043743a345d",
                    "userName": "liubo3",
                    "timeTrigger": null,
                    "conditions": [
                        {
                            "productName": "cdedd",
                            "productId": 100235,
                            "labelId": null,
                            "labelName": null,
                            "protocolType": 5,
                            "check": {
                                "parameter": "abcd",
                                "operation": "!=",
                                "operand": "true",
                                "type": 2
                            },
                            "type": 2,
                            "nameList": [
                                "crcr"
                            ],
                            "didList": [
                                10000781
                            ]
                        }
                    ],
                    "filters": [],
                    "actions": [
                        {
                            "deviceId": 10000781,
                            "deviceName": "crcr",
                            "productName": "cdedd",
                            "productId": 100235,
                            "protocolType": 5,
                            "identifier": "abcd",
                            "value": "true",
                            "type": 2
                        }
                    ],        
                    "subscription": [],
                    "mailServerId": "",
                    "mailServerName": "",
                    "mailPatternId": "",
                    "mailPatternName": "",           
                    "export": false,
                    "exportClientId": null,           
                    "ruleType": 1
                 }
               ]
           }
}

10.1.6启用规则

功能描述：启用物联网中的特定规则引擎，使规则引擎能够进行条件触发，执行相应的动作。

PUT  /api/v1/rules/{ruleId}/enable

Path:

cURL example:

   curl --location --request PUT '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/rules/{ruleId}/enable?accessKeyId={accessKeyId}&signature={signature}&signatureNonce=646' \
 --header 'platform: 1' \
 --header 'projectId: {projectId}'

Response example:

{
    "success": true,
    "code": 0,
    "msg": null,
    "data": null
}

10.1.7禁用规则

功能描述：禁用物联网中的特定规则，禁止规则进行条件触发，执行相应的动作。

PUT  /api/v1/rules/{ruleId}/disable

Path:

cURL example:

   curl --location --request PUT '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/rules/{ruleId}/disable?accessKeyId={accessKeyId}&signature={signature}&signatureNonce=646' \
 --header 'platform: 1' \
 --header 'projectId: {projectId}'

Response example:

{
    "success": true,
    "code": 0,
    "msg": null,
    "data": null
}

10.1.8批量删除规则

功能描述：根据id列表批量删除规则。

DELETE  /api/v1/rules

Body:

Body example:

["8ae48daf7163309a0171ee0575150010","9ae48daf7163309a0171ee0575150010"]

cURL example:

   curl --location --request DELETE '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/rules?accessKeyId={accessKeyId}&signature={signature}&signatureNonce=646' \
 --header 'platform: 1' \
 --header 'projectId: {projectId}' \
 --header 'Content-Type: application/json' \
 --data-raw '["8ae48daf7163309a0171ee0575150010","9ae48daf7163309a0171ee0575150010"]'

Response example:

{
    "success": true,
    "code": 0,
    "msg": "",
    "data": null
}

10.1.9更新规则状态

功能描述：批量启用/禁用规则。

POST  /api/v1/rules/status

Body:

Body example:

{
  "ruleId": [
    "8ae48daf7163309a0171ee0575150010"
  ],
  "status": 1
}

cURL example:

   curl --location --request POST '{URI-scheme}://{Endpoint}{path-prefix}/api/v1/rules/status?accessKeyId={accessKeyId}&signature={signature}&signatureNonce=646' \
 --header 'platform: 1' \
 --header 'projectId: {projectId}' \
 --header 'Content-Type: application/json' \
 --data-raw '{
  "ruleId": [
    "8ae48daf7163309a0171ee0575150010"
  ],
  "status": 1
}'

Response example:

{
    "success": true,
    "code": 0,
    "msg": null,
    "data": null
}